GET Attachments?assetId={assetId}&includeContent={includeContent}&take={take}&skip={skip}&sort[0].Field={sort[0].Field}&sort[0].Dir={sort[0].Dir}&sort[1].Field={sort[1].Field}&sort[1].Dir={sort[1].Dir}
Retrieves attachments for the given parameters. All parameters are optional.
Request Information
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
assetId |
Id of the asset |
globally unique identifier |
None. |
includeContent |
Include the file contents of the attachments |
boolean |
Default value is False |
take |
Number of attachments to retrieve. Default is all attachments |
integer |
None. |
skip |
Number of attachments to skip before retrieval |
integer |
Default value is 0 |
sort |
List of sorting rules to describe how to sort the attachments before retrieval |
Collection of Sort |
None. |
Operator | string |
None. |
|
Field | string |
None. |
|
Value | string |
None. |
|
Logic | string |
None. |
|
Filters | Collection of Filter |
None. |
Body Parameters
None.
Response Information
Resource Description
On success, a list of attachments.
Name | Description | Type | Additional information |
---|---|---|---|
Data | Collection of Attachment |
None. |
|
Total | integer |
None. |
|
Message | string |
None. |
Response Formats
application/json, text/json
Sample:
{ "Data": [ { "AttachmentId": "c0c79658-93ed-4c14-bad2-8e8b6bd32c24", "Name": "sample string 1", "Description": "sample string 2", "AttachmentCategory": { "AttachmentCategoryId": "3997ff19-5e3e-446b-8a4e-f73843f8e0fe", "Name": "sample string 1", "SourceSystemId": "sample string 2", "CompanyId": "63293a2a-2d84-421b-877c-6aaf5110409c", "CreateDate": "2024-05-06T12:57:45.8559013-07:00", "CreateUser": "sample string 4", "LastModifiedDate": "2024-05-06T12:57:45.8559013-07:00", "LastModifiedUser": "sample string 5" }, "Asset": { "AssetId": "88806c8c-0f3a-4261-9372-d5a2127ea14b", "Name": "sample string 1", "Description": "sample string 2", "DisplayOrder": 1, "AssetType": { "AssetTypeId": "d298c0ec-d593-46e7-9e05-31a35d464837", "Name": "sample string 1", "Description": "sample string 2", "IsWell": true, "DisplayColor": "sample string 4", "SourceSystemId": "sample string 5", "CompanyId": "c07d2b4f-3772-4b78-9cd9-9ffedc58767e", "CreateDate": "2024-05-06T12:57:45.8559013-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2024-05-06T12:57:45.8559013-07:00", "LastModifiedUser": "sample string 8" }, "AssetGroup": { "AssetGroupId": "a23255be-7e0b-4ab5-978b-f14342c0d5c2", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2024-05-06T12:57:45.8559013-07:00", "MeasurementValueNeededDate": "2024-05-06T12:57:45.8559013-07:00", "SourceSystemId": "sample string 3", "CompanyId": "bfb4fb5a-fca4-4d57-8ebb-bdaf4581628f", "CreateDate": "2024-05-06T12:57:45.8559013-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2024-05-06T12:57:45.8559013-07:00", "LastModifiedUser": "sample string 6" }, "ParentAsset": null, "Location": "sample string 3", "Barcode": { "Format": 0, "Code": "sample string 1" }, "State": { "StateId": "22567e83-ee9f-47a5-8c9f-dbc21b2b8a28", "EffectiveDate": "2024-05-06T12:57:45.8559013-07:00", "StateType": { "StateTypeId": "fd16092f-011e-4d5c-b5e0-63fdc6b5f136", "Name": "sample string 1", "IsOperational": true, "AssetType": { "AssetTypeId": "d298c0ec-d593-46e7-9e05-31a35d464837", "Name": "sample string 1", "Description": "sample string 2", "IsWell": true, "DisplayColor": "sample string 4", "SourceSystemId": "sample string 5", "CompanyId": "c07d2b4f-3772-4b78-9cd9-9ffedc58767e", "CreateDate": "2024-05-06T12:57:45.8559013-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2024-05-06T12:57:45.8559013-07:00", "LastModifiedUser": "sample string 8" }, "SourceSystemId": "sample string 3", "CompanyId": "e643c981-f543-47a9-a93b-6a8af4bdaccd", "CreateDate": "2024-05-06T12:57:45.8559013-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2024-05-06T12:57:45.8559013-07:00", "LastModifiedUser": "sample string 6" }, "SourceSystemId": "sample string 1", "CompanyId": "c897d681-4167-4538-b7f4-58caccb46c4f", "CreateDate": "2024-05-06T12:57:45.8559013-07:00", "CreateUser": "sample string 3", "LastModifiedDate": "2024-05-06T12:57:45.8559013-07:00", "LastModifiedUser": "sample string 4" }, "Status": { "StatusId": "657b2312-0d8a-40b9-973e-2bceb7aec83f", "EffectiveDate": "2024-05-06T12:57:45.8559013-07:00", "StatusType": { "StatusTypeId": "b1bec771-1624-40a9-b862-a58b02815c4f", "Name": "sample string 1", "IsProducing": true, "IsInjecting": true, "AssetType": { "AssetTypeId": "d298c0ec-d593-46e7-9e05-31a35d464837", "Name": "sample string 1", "Description": "sample string 2", "IsWell": true, "DisplayColor": "sample string 4", "SourceSystemId": "sample string 5", "CompanyId": "c07d2b4f-3772-4b78-9cd9-9ffedc58767e", "CreateDate": "2024-05-06T12:57:45.8559013-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2024-05-06T12:57:45.8559013-07:00", "LastModifiedUser": "sample string 8" }, "SourceSystemId": "sample string 4", "CompanyId": "c5be7dbe-6b12-45fe-b06e-85f179be7644", "CreateDate": "2024-05-06T12:57:45.8559013-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2024-05-06T12:57:45.8559013-07:00", "LastModifiedUser": "sample string 7" }, "SourceSystemId": "sample string 1", "CompanyId": "78b136c4-3429-49b0-a74f-7fe476b7832f", "CreateDate": "2024-05-06T12:57:45.8559013-07:00", "CreateUser": "sample string 3", "LastModifiedDate": "2024-05-06T12:57:45.8559013-07:00", "LastModifiedUser": "sample string 4" }, "WellPurpose": { "WellPurposeId": "b496c3e0-1dc6-40fa-af23-9d10ebc71a6c", "EffectiveDate": "2024-05-06T12:57:45.8559013-07:00", "WellPurposeType": { "WellPurposeTypeId": "fec37c2c-72a1-4d74-9050-5d3a43c07694", "IsProducer": true, "IsInjector": true, "Name": "sample string 3", "SourceSystemId": "sample string 4", "CompanyId": "f745b6ea-894f-41ac-a3dd-182b50a49e2b", "CreateDate": "2024-05-06T12:57:45.8559013-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2024-05-06T12:57:45.8559013-07:00", "LastModifiedUser": "sample string 7" }, "SourceSystemId": "sample string 1", "CompanyId": "d518df15-4202-4ba9-b2d6-fc3855385f65", "CreateDate": "2024-05-06T12:57:45.8559013-07:00", "CreateUser": "sample string 3", "LastModifiedDate": "2024-05-06T12:57:45.8559013-07:00", "LastModifiedUser": "sample string 4" }, "FormValueNeededDate": "2024-05-06T12:57:45.8559013-07:00", "MeasurementValueNeededDate": "2024-05-06T12:57:45.8559013-07:00", "HasChildren": true, "SourceSystemId": "sample string 5", "CompanyId": "b1850483-0bb4-48ec-a7e7-d03e74e6a4ab", "CreateDate": "2024-05-06T12:57:45.8559013-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2024-05-06T12:57:45.8559013-07:00", "LastModifiedUser": "sample string 8" }, "FileType": "sample string 3", "FileSize": 1, "UploadDate": "2024-05-06T12:57:45.8559013-07:00", "Content": "QEA=", "SourceSystemId": "sample string 4", "CompanyId": "c34afc65-03f9-4562-a6b8-700a59737c70", "CreateDate": "2024-05-06T12:57:45.8559013-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2024-05-06T12:57:45.8559013-07:00", "LastModifiedUser": "sample string 7" }, { "AttachmentId": "c0c79658-93ed-4c14-bad2-8e8b6bd32c24", "Name": "sample string 1", "Description": "sample string 2", "AttachmentCategory": { "AttachmentCategoryId": "3997ff19-5e3e-446b-8a4e-f73843f8e0fe", "Name": "sample string 1", "SourceSystemId": "sample string 2", "CompanyId": "63293a2a-2d84-421b-877c-6aaf5110409c", "CreateDate": "2024-05-06T12:57:45.8559013-07:00", "CreateUser": "sample string 4", "LastModifiedDate": "2024-05-06T12:57:45.8559013-07:00", "LastModifiedUser": "sample string 5" }, "Asset": { "AssetId": "88806c8c-0f3a-4261-9372-d5a2127ea14b", "Name": "sample string 1", "Description": "sample string 2", "DisplayOrder": 1, "AssetType": { "AssetTypeId": "d298c0ec-d593-46e7-9e05-31a35d464837", "Name": "sample string 1", "Description": "sample string 2", "IsWell": true, "DisplayColor": "sample string 4", "SourceSystemId": "sample string 5", "CompanyId": "c07d2b4f-3772-4b78-9cd9-9ffedc58767e", "CreateDate": "2024-05-06T12:57:45.8559013-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2024-05-06T12:57:45.8559013-07:00", "LastModifiedUser": "sample string 8" }, "AssetGroup": { "AssetGroupId": "a23255be-7e0b-4ab5-978b-f14342c0d5c2", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2024-05-06T12:57:45.8559013-07:00", "MeasurementValueNeededDate": "2024-05-06T12:57:45.8559013-07:00", "SourceSystemId": "sample string 3", "CompanyId": "bfb4fb5a-fca4-4d57-8ebb-bdaf4581628f", "CreateDate": "2024-05-06T12:57:45.8559013-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2024-05-06T12:57:45.8559013-07:00", "LastModifiedUser": "sample string 6" }, "ParentAsset": null, "Location": "sample string 3", "Barcode": { "Format": 0, "Code": "sample string 1" }, "State": { "StateId": "22567e83-ee9f-47a5-8c9f-dbc21b2b8a28", "EffectiveDate": "2024-05-06T12:57:45.8559013-07:00", "StateType": { "StateTypeId": "fd16092f-011e-4d5c-b5e0-63fdc6b5f136", "Name": "sample string 1", "IsOperational": true, "AssetType": { "AssetTypeId": "d298c0ec-d593-46e7-9e05-31a35d464837", "Name": "sample string 1", "Description": "sample string 2", "IsWell": true, "DisplayColor": "sample string 4", "SourceSystemId": "sample string 5", "CompanyId": "c07d2b4f-3772-4b78-9cd9-9ffedc58767e", "CreateDate": "2024-05-06T12:57:45.8559013-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2024-05-06T12:57:45.8559013-07:00", "LastModifiedUser": "sample string 8" }, "SourceSystemId": "sample string 3", "CompanyId": "e643c981-f543-47a9-a93b-6a8af4bdaccd", "CreateDate": "2024-05-06T12:57:45.8559013-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2024-05-06T12:57:45.8559013-07:00", "LastModifiedUser": "sample string 6" }, "SourceSystemId": "sample string 1", "CompanyId": "c897d681-4167-4538-b7f4-58caccb46c4f", "CreateDate": "2024-05-06T12:57:45.8559013-07:00", "CreateUser": "sample string 3", "LastModifiedDate": "2024-05-06T12:57:45.8559013-07:00", "LastModifiedUser": "sample string 4" }, "Status": { "StatusId": "657b2312-0d8a-40b9-973e-2bceb7aec83f", "EffectiveDate": "2024-05-06T12:57:45.8559013-07:00", "StatusType": { "StatusTypeId": "b1bec771-1624-40a9-b862-a58b02815c4f", "Name": "sample string 1", "IsProducing": true, "IsInjecting": true, "AssetType": { "AssetTypeId": "d298c0ec-d593-46e7-9e05-31a35d464837", "Name": "sample string 1", "Description": "sample string 2", "IsWell": true, "DisplayColor": "sample string 4", "SourceSystemId": "sample string 5", "CompanyId": "c07d2b4f-3772-4b78-9cd9-9ffedc58767e", "CreateDate": "2024-05-06T12:57:45.8559013-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2024-05-06T12:57:45.8559013-07:00", "LastModifiedUser": "sample string 8" }, "SourceSystemId": "sample string 4", "CompanyId": "c5be7dbe-6b12-45fe-b06e-85f179be7644", "CreateDate": "2024-05-06T12:57:45.8559013-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2024-05-06T12:57:45.8559013-07:00", "LastModifiedUser": "sample string 7" }, "SourceSystemId": "sample string 1", "CompanyId": "78b136c4-3429-49b0-a74f-7fe476b7832f", "CreateDate": "2024-05-06T12:57:45.8559013-07:00", "CreateUser": "sample string 3", "LastModifiedDate": "2024-05-06T12:57:45.8559013-07:00", "LastModifiedUser": "sample string 4" }, "WellPurpose": { "WellPurposeId": "b496c3e0-1dc6-40fa-af23-9d10ebc71a6c", "EffectiveDate": "2024-05-06T12:57:45.8559013-07:00", "WellPurposeType": { "WellPurposeTypeId": "fec37c2c-72a1-4d74-9050-5d3a43c07694", "IsProducer": true, "IsInjector": true, "Name": "sample string 3", "SourceSystemId": "sample string 4", "CompanyId": "f745b6ea-894f-41ac-a3dd-182b50a49e2b", "CreateDate": "2024-05-06T12:57:45.8559013-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2024-05-06T12:57:45.8559013-07:00", "LastModifiedUser": "sample string 7" }, "SourceSystemId": "sample string 1", "CompanyId": "d518df15-4202-4ba9-b2d6-fc3855385f65", "CreateDate": "2024-05-06T12:57:45.8559013-07:00", "CreateUser": "sample string 3", "LastModifiedDate": "2024-05-06T12:57:45.8559013-07:00", "LastModifiedUser": "sample string 4" }, "FormValueNeededDate": "2024-05-06T12:57:45.8559013-07:00", "MeasurementValueNeededDate": "2024-05-06T12:57:45.8559013-07:00", "HasChildren": true, "SourceSystemId": "sample string 5", "CompanyId": "b1850483-0bb4-48ec-a7e7-d03e74e6a4ab", "CreateDate": "2024-05-06T12:57:45.8559013-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2024-05-06T12:57:45.8559013-07:00", "LastModifiedUser": "sample string 8" }, "FileType": "sample string 3", "FileSize": 1, "UploadDate": "2024-05-06T12:57:45.8559013-07:00", "Content": "QEA=", "SourceSystemId": "sample string 4", "CompanyId": "c34afc65-03f9-4562-a6b8-700a59737c70", "CreateDate": "2024-05-06T12:57:45.8559013-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2024-05-06T12:57:45.8559013-07:00", "LastModifiedUser": "sample string 7" } ], "Total": 1, "Message": "sample string 1" }